/* Copyright (c) 2007  Peter Palotas
 *  
 *  This software is provided 'as-is', without any express or implied
 *  warranty. In no event will the authors be held liable for any damages
 *  arising from the use of this software.
 *  
 *  Permission is granted to anyone to use this software for any purpose,
 *  including commercial applications, and to alter it and redistribute it
 *  freely, subject to the following restrictions:
 *  
 *      1. The origin of this software must not be misrepresented; you must not
 *      claim that you wrote the original software. If you use this software
 *      in a product, an acknowledgment in the product documentation would be
 *      appreciated but is not required.
 *  
 *      2. Altered source versions must be plainly marked as such, and must not be
 *      misrepresented as being the original software.
 *  
 *      3. This notice may not be removed or altered from any source
 *      distribution.
 *  
 *  
 *  $Id: ParseErrorCodes.cs 19 2007-08-15 13:14:32Z palotas $
 */

namespace Plossum.CommandLine
{
    /// <summary>
    /// Indicates the type of the error of a <see cref="ErrorInfo"/>.
    /// </summary>
    /// <seealso cref="CommandLineParser.Errors"/>
    public enum ParseErrorCodes
    {
        /// <summary>
        /// A value was quoted but no closing quote was found on the command line.
        /// </summary>
            MissingClosingQuote,
            /// <summary>
            /// An option switch character was specified but without an option name following it.
            /// </summary>
            EmptyOptionName,
            /// <summary>
            /// The option specified does not exist.
            /// </summary>
            UnknownOption,
            /// <summary>
            /// A required option was not specified.
            /// </summary>
            MissingRequiredOption,
            /// <summary>
            /// An assignment character was found where it should not have been on the command line.
            /// </summary>
            UnexpectedAssignment,
            /// <summary>
            /// An option is specified either too many times or too few times on the command line.
            /// </summary>
            IllegalCardinality,
            /// <summary>
            /// An option requiring a value was specified without a value.
            /// </summary>
            MissingValue,
            /// <summary>
            /// An option not accepting a value was explicitly assigned a value.
            /// </summary>
            AssignmentToNonValueOption,
            /// <summary>
            /// An option specified was prohibited by another option that was also specified.
            /// </summary>
            OptionProhibited,
            /// <summary>
            /// A value assigned to a numerical option was outside the range specified by 
            /// <see cref="CommandLineOptionAttribute.MinValue"/> and <see cref="CommandLineOptionAttribute.MaxValue"/>.
            /// </summary>
            Overflow,
            /// <summary>
            /// The value specified for an option was in an invalid format, or an illegal value for the specified type.
            /// </summary>
            InvalidFormat,
            /// <summary>
            /// The file specified was not found, or could not be opened for reading.
            /// </summary>
            FileNotFound,
            /// <summary>
            /// The value specified for the option failed user validation.
            /// </summary>
            InvalidValue,
            /// <summary>
            /// An unknown error occured.
            /// </summary>
            UnknownError
    }
}
